﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg {
    import nanoxml.XMLElement;
    import com.dg.gaming.api.common.TransmissionException;

    /**
     * Chat communications object for chat at a table.
     *
     * @author  Bob Marks
     * @version Alpha 0.2.3
     */
    public class MsgChatTable extends MsgTableMessage {

        /** Chat String. */
        protected var chat:String;

        /**
         * Constructor which creates a CommChatRoom object from the flatten ()
         * method of another CommChatRoom object.
         *
         * @param message
         * @throws TransmissionException
         */
        public function MsgChatTable(chat:String = null, message:XMLElement = null) {

            this.chat = chat;

            if (message != null) {
                super(message);
                this.chat = message.getContent();
                if (message.name != Msg.CHAT_TABLE) {
                    throw new TransmissionException("Error parsing Comm");
                }
            }
        }

        /**
         * Return the text of the message.
         *
         * @return   Chat message from user.
         */
        public function getChat():String {
            return chat;
        }

        /**
         * Transmittable String representation of this object.
         *
         * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
         */
        public override function flatten():XMLElement {
            var message:XMLElement = super.flattenWithName(Msg.CHAT_TABLE);
            message.setContent(chat);

            return message;
        }
    }
}